home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cato
/
Xm
/
XmArrowButtonGadget.z
/
XmArrowButtonGadget
Wrap
Text File
|
1998-10-20
|
21KB
|
331 lines
XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
NNNNAAAAMMMMEEEE
XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt - The ArrowButtonGadget widget class
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////AAAArrrrrrrroooowwwwBBBBGGGG....hhhh>>>>
VVVVEEEERRRRSSSSIIIIOOOONNNN
This page documents version 1.2 of the Motif library.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
ArrowButtonGadget consists of a directional arrow surrounded
by a border shadow. When it is selected, the shadow changes
to give the appearance that the ArrowButtonGadget has been
pressed in. When it is unselected, the shadow reverts to
give the appearance that the button is released, or out.
CCCCllllaaaasssssssseeeessss
ArrowButtonGadget inherits behavior and resources from
OOOObbbbjjjjeeeecccctttt, RRRReeeeccccttttOOOObbbbjjjj, and XXXXmmmmGGGGaaaaddddggggeeeetttt classes.
The class pointer is xxxxmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeettttCCCCllllaaaassssssss.
The class name is XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt.
NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
The following table defines a set of widget resources used
by the programmer to specify data. The programmer can also
set the resource values for the inherited classes to set
attributes for this widget. To reference a resource by name
or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
prefix and use the remaining letters. To specify one of the
defined values for a resource in a .Xdefaults file, remove
the XXXXmmmm prefix and use the remaining letters (in either
lowercase or uppercase, but include any underscores between
words). The codes in the access column indicate if the
given resource can be set at creation time (C), set by using
XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
not applicable (N/A).
AAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
______________________________________________________________________________
XmNactivateCallback XmCCallback XtCallbackList NULL C
XmNarmCallback XmCCallback XtCallbackList NULL C
XmNarrowDirection XmCArrowDirection unsigned char XmARROW_UP CSG
XmNdisarmCallback XmCCallback XtCallbackList NULL C
XmNmultiClick XmCMultiClick unsigned char dynamic CSG
XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
Specifies a list of callbacks that is called when
Page 1 (printed 4/30/98)
XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
the ArrowButtonGadget is activated. To activate
the button, press and release BBBBSSSSeeeelllleeeecccctttt while the
pointer is inside the ArrowButtonGadget.
Activating the ArrowButtonGadget also disarms it.
The reason sent by this callback is XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.
XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
Specifies a list of callbacks that is called when
the ArrowButtonGadget is armed. To arm this
widget, press BBBBSSSSeeeelllleeeecccctttt while the pointer is inside
the ArrowButtonGadget. The reason sent by this
callback is XXXXmmmmCCCCRRRR____AAAARRRRMMMM.
XXXXmmmmNNNNaaaarrrrrrrroooowwwwDDDDiiiirrrreeeeccccttttiiiioooonnnn
Sets the arrow direction. The values for this
resource are:
+o XXXXmmmmAAAARRRRRRRROOOOWWWW____UUUUPPPP.
+o XXXXmmmmAAAARRRRRRRROOOOWWWW____DDDDOOOOWWWWNNNN.
+o XXXXmmmmAAAARRRRRRRROOOOWWWW____LLLLEEEEFFFFTTTT.
+o XXXXmmmmAAAARRRRRRRROOOOWWWW____RRRRIIIIGGGGHHHHTTTT.
XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
Specifies a list of callbacks that is called when
the ArrowButtonGadget is disarmed. To disarm this
widget, press and release BBBBSSSSeeeelllleeeecccctttt while the
pointer is inside the ArrowButtonGadget. The
reason sent by this callback is XXXXmmmmCCCCRRRR____DDDDIIIISSSSAAAARRRRMMMM.
XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
If a button click is followed by another button
click within the time span specified by the
display's multi-click time, and this resource is
set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, do not process the
second click. If this resource is set to
XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, process the event and increment
_c_l_i_c_k__c_o_u_n_t in the callback structure. When the
ArrowButtonGadget is not in a menu, the default
value is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP.
IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
ArrowButtonGadget inherits behavior and resources from the
following superclasses. For a complete description of each
resource, refer to the man page for that superclass.
XXXXmmmmGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
Page 2 (printed 4/30/98)
XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
___________________________________________________________________________________
XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic G
XmNhelpCallback XmCCallback XtCallbackList NULL C
XmNhighlightColor XmCHighlightColor Pixel dynamic G
XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG
XmNhighlightThickness XmCHighlightThickness Dimension 2 CSG
XmNnavigationType XmCNavigationType XmNavigationType XmNONE CSG
XmNshadowThickness XmCShadowThickness Dimension 2 CSG
XmNtopShadowColor XmCTopShadowColor Pixel dynamic G
XmNtraversalOn XmCTraversalOn Boolean True CSG
XmNunitType XmCUnitType unsigned char dynamic CSG
XmNuserData XmCUserData XtPointer NULL CSG
RRRReeeeccccttttOOOObbbbjjjj RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
____________________________________________________________________
XmNancestorSensitive XmCSensitive Boolean dynamic G
XmNborderWidth XmCBorderWidth Dimension 0 CSG
XmNheight XmCHeight Dimension dynamic CSG
XmNsensitive XmCSensitive Boolean True CSG
XmNwidth XmCWidth Dimension dynamic CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
____________________________________________________________________
XmNdestroyCallback XmCCallback XtCallbackList NULL C
CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
A pointer to the following structure is passed to each
callback:
ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
{{{{
iiiinnnntttt _r_e_a_s_o_n;;;;
XXXXEEEEvvvveeeennnntttt * _e_v_e_n_t;;;;
iiiinnnntttt _c_l_i_c_k__c_o_u_n_t;;;;
}}}} XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
_r_e_a_s_o_n Indicates why the callback was invoked.
_e_v_e_n_t Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback.
_c_l_i_c_k__c_o_u_n_t
This value is valid only when the reason is
XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE. It contains the number of clicks in
the last multiclick sequence if the XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
resource is set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, otherwise it
contains 1111. The activate callback is invoked for
Page 3 (printed 4/30/98)
XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
each click if XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is set to
XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP.
BBBBeeeehhhhaaaavvvviiiioooorrrr
XmArrowButtonGadget includes behavior from XmGadget.
Additional XmArrowButtonGadget behavior is described below:
BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:
Draws the shadow in the selected state and calls
the callbacks for XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
BBBBSSSSeeeelllleeeecccctttt CCCClllliiiicccckkkk oooorrrr BBBBSSSSeeeelllleeeeccccttttRRRReeeelllleeeeaaaasssseeee:
Draws the shadow in the unselected state. If the
pointer is within the ArrowButtonGadget, calls the
callbacks for XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk. Calls the
callbacks for XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss 2222++++:
If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
action does nothing. If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is
XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action draws the shadow in
the selected state and calls the callbacks for
XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee 2222++++:
If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
action does nothing.
If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action
does the following: Increments _c_l_i_c_k__c_o_u_n_t in the
callback structure. Draws the shadow in the
unselected state. If the pointer is within the
ArrowButtonGadget, calls the callbacks for
XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk. Calls the callbacks for
XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
KKKKSSSSeeeelllleeeecccctttt: Draws the shadow in the selected state and calls
the callbacks for XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk. Arranges for
the shadow to be drawn in the unselected state and
the callbacks for XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk and
XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk to be called, either immediately
or at a later time.
KKKKHHHHeeeellllpppp: Calls the callbacks for XXXXmmmmNNNNhhhheeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any
exist. If there are no help callbacks for this
widget, this calls the help callbacks for the
nearest ancestor that has them.
<<<<EEEEnnnntttteeeerrrr>>>>: Draws the ArrowButtonGadget shadow in its selected
state if the pointer leaves and re-enters the
Page 4 (printed 4/30/98)
XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
gadget while BSelect is pressed.
<<<<LLLLeeeeaaaavvvveeee>>>>: Draws the ArrowButtonGadget shadow in its
unselected state if the pointer leaves the gadget
while BSelect is pressed.
VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
The bindings for virtual keys are vendor specific. For
information about bindings for virtual buttons and keys, see
VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
OOOObbbbjjjjeeeecccctttt((((3333XXXX)))), RRRReeeeccccttttOOOObbbbjjjj((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))), and
XXXXmmmmGGGGaaaaddddggggeeeetttt((((3333XXXX)))).
Page 5 (printed 4/30/98)